Making an API request

The API has a RESTful API design which uses GET, POST, PUT, and PATCH methods.

Every API request must be authenticated using NTLM (Windows) authentication, based on a Windows domain user account. There is no maintained user session (unlike the Planning Space Web API).

The form of all Web API requests is

{host}/{resource}

where 'host' is the address of an IPS server, and the request resource begins with one of the three endpoints: 'admin', 'licenseserver' or 'monitor'.

In this documentation, the host is given the generic value 'https://ipsserver.mycompany.com'.

 

IN THIS SECTION